//==============================================================================
//
//  @@-COPYRIGHT-START-@@
//
//  Copyright (c) 2025, Qualcomm Innovation Center, Inc. All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions are met:
//
//  1. Redistributions of source code must retain the above copyright notice,
//     this list of conditions and the following disclaimer.
//
//  2. Redistributions in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation
//     and/or other materials provided with the distribution.
//
//  3. Neither the name of the copyright holder nor the names of its contributors
//     may be used to endorse or promote products derived from this software
//     without specific prior written permission.
//
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
//  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
//  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
//  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
//  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
//  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
//  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
//  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
//  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
//  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
//  POSSIBILITY OF SUCH DAMAGE.
//
//  SPDX-License-Identifier: BSD-3-Clause
//
//  @@-COPYRIGHT-END-@@
//
//==============================================================================

#ifndef I_CONTIGUOUS_ENCODING_ANALYZER_HPP
#define I_CONTIGUOUS_ENCODING_ANALYZER_HPP

#include "DlQuantization/IQuantizationEncodingAnalyzer.hpp"


namespace DlQuantization
{

/**
 * @class ContiguousEncodingAnalyzerBase
 * @brief Base class for blockwise encoding analyzers which require data for each block
 *        to be contiguous in memory.
 */
template <typename DTYPE>
class ContiguousEncodingAnalyzerBase : public IBlockEncodingAnalyzer<DTYPE>
{
public:
    virtual ~ContiguousEncodingAnalyzerBase() = default;

    virtual void resetStats() = 0;

    void updateStats(const DTYPE* tensor, const TensorDims& tensorShape, ComputationMode tensorCpuGpuMode,
                     IAllocator* allocator = nullptr, void* stream = nullptr) override;

    virtual std::vector<TfEncoding> computeEncoding(uint8_t bw, bool useSymmetricEncodings, bool useStrictSymmetric,
                                                    bool useUnsignedSymmetric, double zeroPointShift) const = 0;

    virtual std::vector<std::vector<std::tuple<double, double>>> getStatsHistogram() const = 0;

    TensorDims getShape();

protected:
    virtual void updateStatsContiguous(const DTYPE* tensor, const TensorDims& shape, size_t blockSize,
                                       ComputationMode tensorCpuGpuMode, IAllocator* allocator = nullptr,
                                       void* stream = nullptr) = 0;

    TensorDims _shape;
};


}   // namespace DlQuantization


#endif   // I_CONTIGUOUS_ENCODING_ANALYZER_HPP
